home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / wlist141.zip / WILDLIST.DOC < prev    next >
Text File  |  1992-09-20  |  16KB  |  388 lines
  1.  
  2.  
  3.  
  4.                                W I L D L I S T
  5.                 Filelist Utility for WildCat! BBS Operators
  6.  
  7.  
  8.                                Richard Skinner
  9.                             409-260-1883 (voice)
  10.                          409-846-0754 (V32.b V42.b)
  11.                              FidoNet  1:117/112
  12.  
  13.  
  14.  
  15. Overview:
  16. ~~~~~~~~ 
  17. WildList! is a filelist generation utility for use with the WildCat! BBS
  18. software, version 3.0 or higher.
  19.  
  20. WildList! is extremely fast and customizable.  Beta testers have reported
  21. processing in excess of 80 files per second!
  22.  
  23. Unlike some other filelist utilities, there is no maximum number of files
  24. which WildList! can process.  Ok, there is a limit of 2 billion files.
  25.  
  26. WildList! is DESQview-aware.
  27.  
  28. WildList! Supports Novell, and Share type networks.
  29.  
  30. Wildlist! is fully multinode compatible.
  31.  
  32. A WildCat! BBS Operator may customize WildList! in many ways, resulting in a
  33. filelist that is unique to their BBS.  The "secret" to this customization
  34. lies in the WildList! configuration file which is discussed later in these
  35. DOCs.
  36.  
  37. Wildlist comes with a demo key called wildlist.key. If this key file is
  38. expired when you get this archive, then download a new key file from one
  39. of the support sites listed at the end of this file.
  40.  
  41.  
  42.  
  43.  
  44. Command Line Parameters:
  45. ~~~~~~~~~~~~~~~~~~~~~~~ 
  46.       a. Files Listing:
  47.  
  48.             From the command line,
  49.  
  50.                   WILDLIST WILDLIST.CFG
  51.  
  52.             will generate the filelist and/or bulletin file, customized in
  53.             accordance with the configuration instructions within the
  54.             WILDLIST.CFG file.  A configuration file MUST be specified, but any
  55.             number of configuration files may be used if the WildCat! BBS
  56.             Operator desires.
  57.  
  58.       b. New Files Listing:
  59.  
  60.             From the command line,
  61.  
  62.                   WILDLIST WILDLIST.CFG 30
  63.  
  64.             will generate a filelist and/or a bulletin file of all new files
  65.             uploaded in the last 30 days.  Again, a configuration file MUST be
  66.             specified, but any number of configuration files may be used if the
  67.             WildCat! BBS Operator desires.
  68.  
  69.       c.  Global File Listing:
  70.  
  71.             From the command line,
  72.  
  73.                   WILDLIST WILDLIST.CFG GLOBAL
  74.  
  75.             will generate a alphabetized file list of all the files you have
  76.             specified on Line 7. Its best to use the Exclude command on this
  77.             type set up since the entire file database is scanned.
  78.  
  79.       d.  Adding a File:
  80.  
  81.             Normally, WildList! will only update an existing file in the
  82.             WildCat! database with the fresh file stats if the Freshen option
  83.             is turned on by Line 9.
  84.  
  85.             Sometimes, people create a new list that is not in the database
  86.             already, and the sysop must manually add the file and move it. 
  87.             WildList! has a new command line parameter for this:
  88.  
  89.                   WILDLIST WILDLIST.CFG ADD 28
  90.  
  91.             If a command line like the above is used, WildList! will create the
  92.             database entry with the filename and path specified in your config
  93.             file then freshens it.
  94.  
  95.             The Add switch must always be the 2rd parameter and the Area which
  96.             the file should put in will always be the 3rd parameter.  With this
  97.             option, you still need to enter the file description as wildlist
  98.             will only create the Filename, Size, Date, and Default flags in the
  99.             database.
  100.  
  101.             Remember, if your path to this file is different from the area that
  102.             you specified, the actual filepath will be inserted into the
  103.             database, making the file still available.
  104.  
  105.  
  106. WildList! Configuration File:
  107. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  108. C:\WC30                       Line 1:     Path to the widlCat! BBS files
  109.  
  110. C:\WC30\117-000.LST           Line 2:     Full pathname for the filelist
  111.                                           output file.  This is a straght pure
  112.                                           ASCII file created before
  113.                                           compression.
  114.  
  115. C:\WC30\AREA1\ALLFILE.ZIP     Line 3:     Full pathname for the compressed
  116.                                            filelist.  If not using the Freshen
  117.                                            option, this can be any name.
  118.  
  119.                               NOTE: If using the Freshen option, then this
  120.                               path should be the same as the one in MAKEWILD
  121.                               for the area were your file list will reside.
  122.  
  123.                               Example: From MAKEWILD, File Area Definition,
  124.                               let's say your downloadable filelist is in
  125.                               Area #1, C:\WC30\AREA1, and the name of the
  126.                               compressed filelist is ALLFILES.ZIP.  On line
  127.                               3, then, the full pathanme to this file would
  128.                               be: C:\WC30\AREA1\ALLFILES.ZIP
  129.  
  130. ARJ.EXE a                     Line 4:    Name of the compression utility to
  131.                                          use, including any pre-filename
  132.                                          switches.  Put the word "NONE" here
  133.                                          if you do not want this option.
  134.  
  135.                               NOTE: Refer to your compression utility's DOCs
  136.                               for additional info regarding the use of
  137.                               command line switches.
  138.  
  139. -d -y                         Line 5:    Post-filename switches, if any, that
  140.                                          are supported by the compression
  141.                                          utility.
  142.  
  143.                               NOTE: Refer to your compression utility's DOCs
  144.                               for additional info regarding the use of
  145.                               command line switches.
  146.  
  147. ▓                             Line 6:     This is the filler character for
  148.                                           WLIST to use when making the file
  149.                                           area header.  A "+" character would
  150.                                           cause the Area Name to be displayed
  151.                                           as:
  152.                                           ++++++++++++++++ Games ++++++++++++++
  153.  
  154.                                           Any keyboard character should work
  155.                                           fine here.
  156.  
  157. Include 1 3 31-32 45          Line 7:     Areas to include in the filelist.
  158.                                           You may use either the "Include" or
  159.                                           "Exclude" command, but not both.
  160.  
  161.                               Example: "Include 1-21 25 28 30-49" would
  162.                               include all file areas from 1 thru 21, plus
  163.                               area 25, area 28, and areas 30 thru 49.  Only
  164.                               these areas would be included in the filelist.
  165.  
  166.                               "Exclude 1-21 25 28 30-49" would include all
  167.                               areas EXCEPT areas 1 thru 21, area 25, area
  168.                               28, and areas 30 thru 49.  All other areas
  169.                               would be included in the filelist.
  170.  
  171.                               Either blank spaces or commas may be used to
  172.                               delimit areas, i.e. "21 24 30" is the same as
  173.                               "21,24,30" and means areas 21, 24, and 30.
  174.  
  175.                               Delimeters can be used in combination, i.e.
  176.                               1-10 13 15 18,20 27-40
  177.  
  178. D                             Line 8:     Determine how detailed the output
  179.                                           should be, where "S" is Single Line,
  180.                                           and "D" is Double Line.
  181.  
  182.  
  183.  Example of the Single Line Output:
  184.  
  185.  0154PICP.GIF  148k  1w blonde laying on raft
  186.  0159PICR.GIF  151k  1w woman in lacy blue outfit
  187.  0160PICP.GIF   97k  1w black lacy outfit
  188.  0293PICP.GIF  116k  1w in white outfit
  189.  0378PICG.GIF  196k  1w blonde posing on beach
  190.  1BIKINI.GIF   245k  1w brunette in shiny suit
  191.  2SNAP.GIF     139k  1w in green outfit with motorcycle
  192.  370PIC.GIF    162k  1w laying on lounge chair
  193.  
  194.  
  195.  Example Of Double Line :
  196.  
  197.  ABY5_40.ZIP   188,012   07/26/88 | Free-form database. Like 3x5 cards. v4.0
  198.  DwnLds: 0     LastDL:   01/01/00 |
  199.  
  200.  A2Z10.ZIP     245,901   11/22/88 | Flat-file DBMS.
  201.  DwnLds: 0     LastDL:   01/01/00 |
  202.  
  203.  ABC_FILE.ZIP   97,780   08/04/87 | A file manager. Easy as ABC.
  204.  DwnLds: 0     LastDL:   01/01/00 |
  205.  
  206.  ADDRESB.ZIP    28,238   04/21/88 | Address book in dBase III
  207.  DwnLds: 0     LastDL:   01/01/00 |
  208.  
  209.  ADDRESS.ZIP    21,730   08/04/87 | Nice address/phone manager. BASIC source
  210.  DwnLds: 0     LastDL:   01/01/00 |
  211.  
  212.  ADDRESS2.ZIP   65,211   12/08/88 | Personal address manager.
  213.  DwnLds: 0     LastDL:   01/01/00 |
  214.  
  215.  
  216.  
  217. Y                             Line 9:     Freshen the File Size/Date in the
  218.                                           Wildcat! file database?  For further
  219.                                           discussion regarding the Freshen
  220.                                           option, see Line 3 above.
  221.  
  222. N                             Line 10:    Check for the optional ###.HDR Area
  223.                                           Header Files?
  224.  
  225.                               If 1.HDR exist and this option is turned on
  226.                               then your Area Header Name will be replaced by
  227.                               the Contents of the 1.HDR file. One .HDR file
  228.                               per Area is allowed.
  229.  
  230. N                             Line 11:    Include File Size and total number
  231.                                           of area files at the bottom of each
  232.                                           Area, and Grand Total of files and
  233.                                           Total Bytes at the bottom of the
  234.                                           filelist?
  235.  
  236. N                             Line 12:    Include a list of the Top Ten
  237.                                           Downloads for each Area?
  238.  
  239. N                             Line 13:    Include the ASCII file AD.HDR at the
  240.                                           beginning of the filelist if it
  241.                                           exists?
  242.  
  243.                               This option, if used (Y) also includes a file
  244.                               called END.HDR at the end of the filelist.  If
  245.                               creating bulletins, all the files will be .BUL
  246.                               instead of .HDR , This permits the use of
  247.                               @Codes@ in the bulletins but not in the
  248.                               downloadable filelist.
  249.  
  250. N 1                           Line 14:    Append results to the Wildcat!
  251.                                           Activity Log?
  252.  
  253.                               If "Y," then the log number (Node) is required.
  254.                               Example: Y 1 will append to ACTIVITY.001
  255.  
  256. N                             Line 15:    Delete the original output file?
  257.                                           See discussion at Line 2 above.
  258.  
  259.                               This option works only if Line 4 is set to
  260.                               something besides None.
  261.  
  262. N                             Line 16:    Include Password/Offline Files?  If
  263.                                           "Y," P will replace "|" character
  264.                                           (for  Password files) or O (for
  265.                                           Offline files), exactly like the
  266.                                           screen output when a caller is doing
  267.                                           a (L)ist Files in WildCat!
  268.  
  269. List                          Line 17:    Accepts : BULL  LIST  BOTH
  270.  
  271.                               BULL - will create a bulletin Only with the
  272.                               @color@ codes Only.
  273.  
  274.                               useage > BULL  Bul1.cfg Bull.cfg is the name
  275.                               of your config file that contains all the
  276.                               @COLOR@ stuff you want to use for that
  277.                               bulletin.
  278.  
  279.                               See the sample Bul1.cfg file.
  280.  
  281.                               LIST - Creates a normal File List - No
  282.                               Parameters - No Color
  283.  
  284.                               usage > LIST
  285.  
  286.                               BOTH - Creates a bulletin and a Normal File
  287.                               List.  Uses the same Parameters as BULL
  288.  
  289.                               useage > BOTH Bul1.cfg
  290.  
  291. Y                             Line 18:    Do you wish to insert your own
  292.                                           desciption ?
  293.  
  294.                               Example -  You wish people to see your adult
  295.                               file list before they get access... You can
  296.                               enter a default file description for the
  297.                               public to see instead of the regular
  298.                               description.
  299.  
  300.                               For your normal adult list, you would ofcourse
  301.                               want the real Descriptions.  If your not sure
  302.                               of this option, you can contact me or leave it
  303.                               alone, or maybe even experiment with it.
  304.  
  305. Description Omitted           Line 19:    This would be the alternate file
  306.                                           description.
  307.  
  308. 31-35                         Line 20:    These are the areas that will get
  309.                                           the Alternate file descriptions.
  310.  
  311.                               usage : 31 32 34-38  or 31,32,34-38  All files
  312.                               in these areas will have the description from
  313.                               line 19 inserted, the rest of the areas would
  314.                               have the regular database description.
  315.  
  316.  
  317.  
  318. WildList will Ignore everything past the 20th line, so comments are Ok!
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325. Support
  326. ~~~~~~~
  327.                Support by Netmail to the Author is available @
  328.  
  329.                               Fido  1:117/112
  330.                               Richard Skinner
  331.                                V.32b / V.42b
  332.  
  333.  
  334.                    Other Support Sites are listed below.
  335.                    You may obtain the latest version and
  336.                    a current Demo key from these sites.
  337.  
  338.                               Fido 1:117/120
  339.                                 Jim Vargas
  340.                                USR HST 14.4
  341.  
  342.                               Fido  1:281/2
  343.                                 Mike Ortiz
  344.                                USR DS  16.8
  345.  
  346.  
  347.  
  348. Registration
  349. ~~~~~~~~~~~~
  350.  
  351.  Fill Out the Register.Frm file with all the info and include it along
  352.  with a Check or Money Order in the amount of $15 US dollars to :
  353.  
  354.                              Richard Skinner
  355.                              802-A Eagle Pass
  356.                              Bryan,Tx  77802
  357.  
  358.                                 << OR >>
  359.  
  360.           For even faster registration, use your credit card !
  361.     MasterCard / Visa / American Express / Diners Club / Carte Blanche
  362.  
  363.                              Richard Skinner
  364.                              (409) 260-1883
  365.                            5pm - 10pm WeekDays
  366.                            9am - 10pm WeekEnds
  367.  
  368.  Have you WildCat! Registration Number, Card Number, Exp Date, BBS Name
  369.  Available upon request.
  370.  
  371.  
  372.  
  373. Disclaimer
  374. ~~~~~~~~~~
  375.   While we have taken every care to provide a working, stable program, we
  376.   cannot be responsible for any damages that may arise because of the use
  377.   of this program.  You use it at your own risk, plain and simple.
  378.  
  379.  
  380.  
  381.  
  382.  Thanks to Jim Vargas for the Docs !
  383.  
  384.  Thanks for Supporting Shareware!
  385.  Richard Skinner - TMS Computers
  386.  
  387.  
  388.